<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.orders.html">orders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(profileId, projectId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one order by ID.</p>
<p class="toc_element">
  <code><a href="#list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of orders, possibly filtered. This method supports paging.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(profileId, projectId, id, x__xgafv=None)</code>
  <pre>Gets one order by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  id: string, Order ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes properties of a Planning order.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this order.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this order.
  &quot;approverUserProfileIds&quot;: [ # IDs for users that have to approve documents created for this order.
    &quot;A String&quot;,
  ],
  &quot;buyerInvoiceId&quot;: &quot;A String&quot;, # Buyer invoice ID associated with this order.
  &quot;buyerOrganizationName&quot;: &quot;A String&quot;, # Name of the buyer organization.
  &quot;comments&quot;: &quot;A String&quot;, # Comments in this order.
  &quot;contacts&quot;: [ # Contacts for this order.
    { # Contact of an order.
      &quot;contactInfo&quot;: &quot;A String&quot;, # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
      &quot;contactName&quot;: &quot;A String&quot;, # Name of this contact.
      &quot;contactTitle&quot;: &quot;A String&quot;, # Title of this contact.
      &quot;contactType&quot;: &quot;A String&quot;, # Type of this contact.
      &quot;signatureUserProfileId&quot;: &quot;A String&quot;, # ID of the user profile containing the signature that will be embedded into order documents.
    },
  ],
  &quot;id&quot;: &quot;A String&quot;, # ID of this order. This is a read-only, auto-generated field.
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#order&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this order.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this order.
  &quot;notes&quot;: &quot;A String&quot;, # Notes of this order.
  &quot;planningTermId&quot;: &quot;A String&quot;, # ID of the terms and conditions template used in this order.
  &quot;projectId&quot;: &quot;A String&quot;, # Project ID of this order.
  &quot;sellerOrderId&quot;: &quot;A String&quot;, # Seller order ID associated with this order.
  &quot;sellerOrganizationName&quot;: &quot;A String&quot;, # Name of the seller organization.
  &quot;siteId&quot;: [ # Site IDs this order is associated with.
    &quot;A String&quot;,
  ],
  &quot;siteNames&quot;: [ # Free-form site names this order is associated with.
    &quot;A String&quot;,
  ],
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this order.
  &quot;termsAndConditions&quot;: &quot;A String&quot;, # Terms and conditions of this order.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
  <pre>Retrieves a list of orders, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  projectId: string, Project ID for orders. (required)
  ids: string, Select only orders with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, &quot;order*2015&quot; will return orders with names like &quot;order June 2015&quot;, &quot;order April 2015&quot;, or simply &quot;order 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;order&quot; will match orders with name &quot;my order&quot;, &quot;order 2015&quot;, or simply &quot;order&quot;.
  siteId: string, Select only orders that are associated with these site IDs. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Order List Response
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#ordersListResponse&quot;.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
  &quot;orders&quot;: [ # Order collection.
    { # Describes properties of a Planning order.
      &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this order.
      &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this order.
      &quot;approverUserProfileIds&quot;: [ # IDs for users that have to approve documents created for this order.
        &quot;A String&quot;,
      ],
      &quot;buyerInvoiceId&quot;: &quot;A String&quot;, # Buyer invoice ID associated with this order.
      &quot;buyerOrganizationName&quot;: &quot;A String&quot;, # Name of the buyer organization.
      &quot;comments&quot;: &quot;A String&quot;, # Comments in this order.
      &quot;contacts&quot;: [ # Contacts for this order.
        { # Contact of an order.
          &quot;contactInfo&quot;: &quot;A String&quot;, # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
          &quot;contactName&quot;: &quot;A String&quot;, # Name of this contact.
          &quot;contactTitle&quot;: &quot;A String&quot;, # Title of this contact.
          &quot;contactType&quot;: &quot;A String&quot;, # Type of this contact.
          &quot;signatureUserProfileId&quot;: &quot;A String&quot;, # ID of the user profile containing the signature that will be embedded into order documents.
        },
      ],
      &quot;id&quot;: &quot;A String&quot;, # ID of this order. This is a read-only, auto-generated field.
      &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#order&quot;.
      &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this order.
        &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
      },
      &quot;name&quot;: &quot;A String&quot;, # Name of this order.
      &quot;notes&quot;: &quot;A String&quot;, # Notes of this order.
      &quot;planningTermId&quot;: &quot;A String&quot;, # ID of the terms and conditions template used in this order.
      &quot;projectId&quot;: &quot;A String&quot;, # Project ID of this order.
      &quot;sellerOrderId&quot;: &quot;A String&quot;, # Seller order ID associated with this order.
      &quot;sellerOrganizationName&quot;: &quot;A String&quot;, # Name of the seller organization.
      &quot;siteId&quot;: [ # Site IDs this order is associated with.
        &quot;A String&quot;,
      ],
      &quot;siteNames&quot;: [ # Free-form site names this order is associated with.
        &quot;A String&quot;,
      ],
      &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this order.
      &quot;termsAndConditions&quot;: &quot;A String&quot;, # Terms and conditions of this order.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>